Skip to content

INT-4231: Add FileExistsMode.REPLACE_IF_MODIFIED #2062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

INT-4231: Add FileExistsMode.REPLACE_IF_MODIFIED #2062

wants to merge 2 commits into from

Conversation

@garyrussell
Copy link
Contributor

@garyrussell garyrussell commented Feb 21, 2017

JIRA: https://jira.spring.io/browse/INT-4231

For FileWritingMessageHandler and (S)FTP outbound gateways, support
FileExistsMode.REPLACE_IF_MODIFIED to allow overwriting an existing file if
the source file modified time is different to the existing file.

@garyrussell
INT-4231: Add FileExistsMode.REPLACE_IF_MODIFIED
1ff8bed 
JIRA: https://jira.spring.io/browse/INT-4231

For `FileWritingMessageHandler` and (S)FTP outbound gateways, support
`FileExistsMode.REPLACE_IF_MODIFIED` to allow overwriting an existing file if
the source file modified time is different to the existing file.
@artembilan
Copy link
Member

artembilan commented Feb 21, 2017

@garyrussell , would you mind taking a look to my comment in JIRA: https://jira.spring.io/browse/INT-4231?focusedCommentId=135599&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-135599 ?
Thanks

@artembilan
Copy link
Member

artembilan commented Feb 21, 2017

There are a couple errors with JavaDocs according Travis:

:spring-integration-file:javadoc/home/travis/build/spring-projects/spring-integration/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java:839: error: @param name not found

	 * @param lsFirst true to execute an 'ls' command first.

	          ^

/home/travis/build/spring-projects/spring-integration/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java:843: warning: no @param for fileInfoParam

	protected File get(Message<?> message, Session<F> session, String remoteDir, String remoteFilePath,

	               ^

artembilan
artembilan requested changes Feb 21, 2017
View reviewed changes
...ation-file/src/main/java/org/springframework/integration/file/remote/RemoteFileTemplate.java Outdated
Assert.isTrue(!FileExistsMode.APPEND.equals(mode) || !this.useTemporaryFileName,
"Cannot append when using a temporary file name");
Assert.isTrue(!FileExistsMode.REPLACE_IF_MODIFIED.equals(mode),
"FilExistsMode.REPLACE_IF_DIFFERENT can only be used for local files");
Copy link
Member

@artembilan artembilan Feb 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overdid. There is no such a constant FilExistsMode.REPLACE_IF_DIFFERENT 😄

Copy link
Contributor Author

@garyrussell garyrussell Feb 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doh - this was a last-minute change.

...c/main/resources/org/springframework/integration/file/config/spring-integration-file-5.0.xsd
<xsd:documentation><![CDATA[
If the local file already exists, it will be overwritten only
if the last modified timestamp does not match the source
time stamp. Only applies to local files.
Copy link
Member

@artembilan artembilan Feb 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think no reason in the whitespace, like you don't have it in other places.

Copy link
Contributor Author

@garyrussell garyrussell Feb 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?? please explain further.

Copy link
Member

@artembilan artembilan Feb 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other places it is like timestamp, but here it is some how like time stamp.

Copy link
Contributor Author

@garyrussell garyrussell Feb 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah - yes - in future it would be clearer if you said s/time stamp/timestamp/, or explicitly "space between time and stamp" rather than a general statement 😄

...rc/test/java/org/springframework/integration/ftp/outbound/FtpServerOutboundTests-context.xml Outdated
command="mget"
expression="payload"
command-options="-R -P"
mode="REPLACE_IF_DIFFERENT"
Copy link
Member

@artembilan artembilan Feb 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

??? REPLACE_IF_MODIFIED ?
Otherwise:

Caused by: java.lang.IllegalStateException: Cannot convert value of type 'java.lang.String' to required type 'org.springframework.integration.file.support.FileExistsMode' for property 'fileExistsMode': no matching editors or conversion strategy found
	at org.springframework.beans.TypeConverterDelegate.convertIfNecessary(TypeConverterDelegate.java:294)
	at org.springframework.beans.AbstractNestablePropertyAccessor.convertIfNecessary(AbstractNestablePropertyAccessor.java:572)
	... 54 more

.../test/java/org/springframework/integration/sftp/outbound/SftpServerOutboundTests-context.xml Outdated
command="mget"
expression="payload"
command-options="-R -P"
mode="REPLACE_IF_DIFFERENT"
Copy link
Member

@artembilan artembilan Feb 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DITTO

src/reference/asciidoc/file.adoc Outdated
The following options exist:

* REPLACE (Default)
* REPLACE_IF_DIFFERENT
Copy link
Member

@artembilan artembilan Feb 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DITTO

src/reference/asciidoc/whats-new.adoc Outdated
The flush predicates for the `FileWritingMessageHandler` now have an additional parameter.
See <<file-flushing>> for more information.

The file outbound channel adapter (`FileWritingMessageHandler`) now supports the `REPLACE_IF_DIFFERENT` `FileExistsMode`.
Copy link
Member

@artembilan artembilan Feb 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DITTO

@artembilan
Copy link
Member

artembilan commented Feb 22, 2017

Merged as 2d4a7cf

@artembilan artembilan closed this Feb 22, 2017
@garyrussell garyrussell deleted the INT-4231 branch March 17, 2017 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@artembilan artembilan artembilan approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@garyrussell @artembilan